Azure Maps Feature State Service (preview:2.0)

2025/08/14 • 8 deleted methods

FeatureState_CreateStateset (removed)
Description :  **Applies to:** see pricing [tiers](https://aka.ms/AzureMapsPricingTier). Creator makes it possible to develop applications based on your private indoor map data using Azure Maps API and SDK. [This](https://docs.microsoft.com/azure/azure-maps/creator-indoor-maps) article introduces concepts and tools that apply to Azure Maps Creator. This POST API allows the user to create a new Stateset and define stateset style using request body. Creator makes it possible to develop applications based on your private indoor map data using Azure Maps API and SDK. The Feature State API is part of Creator. The Feature State service allows the user to update the states of a feature and query them to be used in other services. The dynamic properties of a feature that don't belong to the dataset are referred to as *states* here. This Feature State service pivot on the Stateset. Like Tileset, Stateset encapsulates the storage mechanism for feature states for a dataset. Once the stateset is created, users can use that statesetId to post feature state updates and retrieve the current feature states. A feature can have only one state at a given point in time. Feature state is defined by the key name, value and the timestamp. When a feature state update is posted to Azure Maps, the state value gets updated only if the provided state’s timestamp is later than the stored timestamp. Azure Maps MapControl provides a way to use these feature states to style the features. Please refer to the [State Tile documentation](https://docs.microsoft.com/en-us/rest/api/maps/render/get-map-state-tile-preview) for more information.
Reference :  Link ¶

⚼ Request

POST:  /featureStateSets
{
subscription-key:
{
Description: One of the Azure Maps keys provided from an Azure Map Account. Please refer to this [article](https://docs.microsoft.com/azure/azure-maps/how-to-manage-authentication) for details on how to manage authentication. ,
Required: False ,
}
string ,
api-version:
{
Description: Version number of Azure Maps API. Current version is 2.0 ,
Required: True ,
}
string ,
datasetId:
{
Description: The datasetId must have been obtained from a successful [Dataset Create API](https://docs.microsoft.com/en-us/rest/api/maps/v2/dataset/create) call. ,
Required: True ,
}
string ,
description:
{
Description: Description for the stateset. Max length allowed is 1000. ,
Required: False ,
}
string ,
statesetCreateRequestBody:
{
Description: The stateset style JSON data. ,
Required: True ,
}
{
styles:
{
Description: An array of stateset styles. The style rule could be a numeric or string or a boolean type style rule. Refer to NumberRuleObject, StringRuleObject and BooleanRuleObject definitions [here](https://aka.ms/AzureMapsStatesetStylesObject). ,
Required: False ,
}
[
object ,
]
,
}
,
}

⚐ Response (200)

{
statesetId:
{
Description: The ID for the new stateset created. ,
Required: False ,
}
string ,
}

⚐ Response (400)

{
error:
{
Description: This object is returned when an error occurs in the Azure Maps API. ,
Required: False ,
}
{
code:
{
Description: The ODataError code. ,
Required: False ,
}
string ,
message:
{
Description: If available, a human-readable description of the error. ,
Required: False ,
}
string ,
details:
{
Required: False ,
}
[
string ,
]
,
target:
{
Description: If available, the target causing the error. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (401)

{
$headers:
{
www-authenticate:
{
Description: Bearer realm="https://atlas.microsoft.com/", error="invalid_token", error_description="The access token expired" ,
}
string ,
}
,
$schema:
{
Description: This response object is returned when an error occurs in the Azure Maps API. ,
}
{
error:
{
Description: This object is returned when an error occurs in the Azure Maps API. ,
Required: False ,
}
{
code:
{
Description: The ODataError code. ,
Required: False ,
}
string ,
message:
{
Description: If available, a human-readable description of the error. ,
Required: False ,
}
string ,
details:
{
Required: False ,
}
[
string ,
]
,
target:
{
Description: If available, the target causing the error. ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (403)

{
error:
{
Description: This object is returned when an error occurs in the Azure Maps API. ,
Required: False ,
}
{
code:
{
Description: The ODataError code. ,
Required: False ,
}
string ,
message:
{
Description: If available, a human-readable description of the error. ,
Required: False ,
}
string ,
details:
{
Required: False ,
}
[
string ,
]
,
target:
{
Description: If available, the target causing the error. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (404)

{
error:
{
Description: This object is returned when an error occurs in the Azure Maps API. ,
Required: False ,
}
{
code:
{
Description: The ODataError code. ,
Required: False ,
}
string ,
message:
{
Description: If available, a human-readable description of the error. ,
Required: False ,
}
string ,
details:
{
Required: False ,
}
[
string ,
]
,
target:
{
Description: If available, the target causing the error. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (500)

{
error:
{
Description: This object is returned when an error occurs in the Azure Maps API. ,
Required: False ,
}
{
code:
{
Description: The ODataError code. ,
Required: False ,
}
string ,
message:
{
Description: If available, a human-readable description of the error. ,
Required: False ,
}
string ,
details:
{
Required: False ,
}
[
string ,
]
,
target:
{
Description: If available, the target causing the error. ,
Required: False ,
}
string ,
}
,
}
FeatureState_ListStateset (removed)
Description :  **Applies to:** see pricing [tiers](https://aka.ms/AzureMapsPricingTier). Creator makes it possible to develop applications based on your private indoor map data using Azure Maps API and SDK. [This](https://docs.microsoft.com/azure/azure-maps/creator-indoor-maps) article introduces concepts and tools that apply to Azure Maps Creator. This API allows the caller to fetch a list of all previously successfully created statesets.
Reference :  Link ¶

⚼ Request

GET:  /featureStateSets
{
subscription-key:
{
Description: One of the Azure Maps keys provided from an Azure Map Account. Please refer to this [article](https://docs.microsoft.com/azure/azure-maps/how-to-manage-authentication) for details on how to manage authentication. ,
Required: False ,
}
string ,
api-version:
{
Description: Version number of Azure Maps API. Current version is 2.0 ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
statesets:
{
Description: A list of statesets information. ,
Required: False ,
}
[
{
statesetId:
{
Description: The stateset ID of this stateset. ,
Required: False ,
}
string ,
description:
{
Description: Description associated with the stateset. ,
Required: False ,
}
string ,
datasetIds:
{
Description: Dataset ID associated with the stateset. ,
Required: False ,
}
[
string ,
]
,
statesetStyle:
{
Description: The styles model. ,
Required: False ,
}
{
styles:
{
Description: An array of stateset styles. The style rule could be a numeric or string or a boolean type style rule. Refer to NumberRuleObject, StringRuleObject and BooleanRuleObject definitions [here](https://aka.ms/AzureMapsStatesetStylesObject). ,
Required: False ,
}
[
object ,
]
,
}
,
}
,
]
,
nextLink:
{
Description: If present, the location of the next page of data. ,
Required: False ,
}
string ,
}

⚐ Response (400)

{
error:
{
Description: This object is returned when an error occurs in the Azure Maps API. ,
Required: False ,
}
{
code:
{
Description: The ODataError code. ,
Required: False ,
}
string ,
message:
{
Description: If available, a human-readable description of the error. ,
Required: False ,
}
string ,
details:
{
Required: False ,
}
[
string ,
]
,
target:
{
Description: If available, the target causing the error. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (401)

{
$headers:
{
www-authenticate:
{
Description: Bearer realm="https://atlas.microsoft.com/", error="invalid_token", error_description="The access token expired" ,
}
string ,
}
,
$schema:
{
Description: This response object is returned when an error occurs in the Azure Maps API. ,
}
{
error:
{
Description: This object is returned when an error occurs in the Azure Maps API. ,
Required: False ,
}
{
code:
{
Description: The ODataError code. ,
Required: False ,
}
string ,
message:
{
Description: If available, a human-readable description of the error. ,
Required: False ,
}
string ,
details:
{
Required: False ,
}
[
string ,
]
,
target:
{
Description: If available, the target causing the error. ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (403)

{
error:
{
Description: This object is returned when an error occurs in the Azure Maps API. ,
Required: False ,
}
{
code:
{
Description: The ODataError code. ,
Required: False ,
}
string ,
message:
{
Description: If available, a human-readable description of the error. ,
Required: False ,
}
string ,
details:
{
Required: False ,
}
[
string ,
]
,
target:
{
Description: If available, the target causing the error. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (404)

{
error:
{
Description: This object is returned when an error occurs in the Azure Maps API. ,
Required: False ,
}
{
code:
{
Description: The ODataError code. ,
Required: False ,
}
string ,
message:
{
Description: If available, a human-readable description of the error. ,
Required: False ,
}
string ,
details:
{
Required: False ,
}
[
string ,
]
,
target:
{
Description: If available, the target causing the error. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (500)

{
error:
{
Description: This object is returned when an error occurs in the Azure Maps API. ,
Required: False ,
}
{
code:
{
Description: The ODataError code. ,
Required: False ,
}
string ,
message:
{
Description: If available, a human-readable description of the error. ,
Required: False ,
}
string ,
details:
{
Required: False ,
}
[
string ,
]
,
target:
{
Description: If available, the target causing the error. ,
Required: False ,
}
string ,
}
,
}
FeatureState_PutStateset (removed)
Description :  **Applies to:** see pricing [tiers](https://aka.ms/AzureMapsPricingTier). Creator makes it possible to develop applications based on your private indoor map data using Azure Maps API and SDK. [This](https://docs.microsoft.com/azure/azure-maps/creator-indoor-maps) article introduces concepts and tools that apply to Azure Maps Creator. This PUT API allows the user to update the stateset style rules.
Reference :  Link ¶

⚼ Request

PUT:  /featureStateSets/{statesetId}
{
subscription-key:
{
Description: One of the Azure Maps keys provided from an Azure Map Account. Please refer to this [article](https://docs.microsoft.com/azure/azure-maps/how-to-manage-authentication) for details on how to manage authentication. ,
Required: False ,
}
string ,
api-version:
{
Description: Version number of Azure Maps API. Current version is 2.0 ,
Required: True ,
}
string ,
statesetId:
{
Description: The stateset id that was created. ,
Required: True ,
}
string ,
statesetStyleUpdateRequestBody:
{
Description: The stateset style JSON data. Only style rules are allowed to be updated, update on keyname and type is not allowed. ,
Required: True ,
}
{
styles:
{
Description: An array of stateset styles. The style rule could be a numeric or string or a boolean type style rule. Refer to NumberRuleObject, StringRuleObject and BooleanRuleObject definitions [here](https://aka.ms/AzureMapsStatesetStylesObject). ,
Required: False ,
}
[
object ,
]
,
}
,
}

⚐ Response (200)

{}

⚐ Response (400)

{
error:
{
Description: This object is returned when an error occurs in the Azure Maps API. ,
Required: False ,
}
{
code:
{
Description: The ODataError code. ,
Required: False ,
}
string ,
message:
{
Description: If available, a human-readable description of the error. ,
Required: False ,
}
string ,
details:
{
Required: False ,
}
[
string ,
]
,
target:
{
Description: If available, the target causing the error. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (401)

{
$headers:
{
www-authenticate:
{
Description: Bearer realm="https://atlas.microsoft.com/", error="invalid_token", error_description="The access token expired" ,
}
string ,
}
,
$schema:
{
Description: This response object is returned when an error occurs in the Azure Maps API. ,
}
{
error:
{
Description: This object is returned when an error occurs in the Azure Maps API. ,
Required: False ,
}
{
code:
{
Description: The ODataError code. ,
Required: False ,
}
string ,
message:
{
Description: If available, a human-readable description of the error. ,
Required: False ,
}
string ,
details:
{
Required: False ,
}
[
string ,
]
,
target:
{
Description: If available, the target causing the error. ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (403)

{
error:
{
Description: This object is returned when an error occurs in the Azure Maps API. ,
Required: False ,
}
{
code:
{
Description: The ODataError code. ,
Required: False ,
}
string ,
message:
{
Description: If available, a human-readable description of the error. ,
Required: False ,
}
string ,
details:
{
Required: False ,
}
[
string ,
]
,
target:
{
Description: If available, the target causing the error. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (404)

{
error:
{
Description: This object is returned when an error occurs in the Azure Maps API. ,
Required: False ,
}
{
code:
{
Description: The ODataError code. ,
Required: False ,
}
string ,
message:
{
Description: If available, a human-readable description of the error. ,
Required: False ,
}
string ,
details:
{
Required: False ,
}
[
string ,
]
,
target:
{
Description: If available, the target causing the error. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (500)

{
error:
{
Description: This object is returned when an error occurs in the Azure Maps API. ,
Required: False ,
}
{
code:
{
Description: The ODataError code. ,
Required: False ,
}
string ,
message:
{
Description: If available, a human-readable description of the error. ,
Required: False ,
}
string ,
details:
{
Required: False ,
}
[
string ,
]
,
target:
{
Description: If available, the target causing the error. ,
Required: False ,
}
string ,
}
,
}
FeatureState_DeleteStateset (removed)
Description :  **Applies to:** see pricing [tiers](https://aka.ms/AzureMapsPricingTier). Creator makes it possible to develop applications based on your private indoor map data using Azure Maps API and SDK. [This](https://docs.microsoft.com/azure/azure-maps/creator-indoor-maps) article introduces concepts and tools that apply to Azure Maps Creator. This DELETE API allows the user to delete the stateset and the associated data.
Reference :  Link ¶

⚼ Request

DELETE:  /featureStateSets/{statesetId}
{
subscription-key:
{
Description: One of the Azure Maps keys provided from an Azure Map Account. Please refer to this [article](https://docs.microsoft.com/azure/azure-maps/how-to-manage-authentication) for details on how to manage authentication. ,
Required: False ,
}
string ,
api-version:
{
Description: Version number of Azure Maps API. Current version is 2.0 ,
Required: True ,
}
string ,
statesetId:
{
Description: The stateset id that was created. ,
Required: True ,
}
string ,
}

⚐ Response (204)

{}

⚐ Response (400)

{
error:
{
Description: This object is returned when an error occurs in the Azure Maps API. ,
Required: False ,
}
{
code:
{
Description: The ODataError code. ,
Required: False ,
}
string ,
message:
{
Description: If available, a human-readable description of the error. ,
Required: False ,
}
string ,
details:
{
Required: False ,
}
[
string ,
]
,
target:
{
Description: If available, the target causing the error. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (401)

{
$headers:
{
www-authenticate:
{
Description: Bearer realm="https://atlas.microsoft.com/", error="invalid_token", error_description="The access token expired" ,
}
string ,
}
,
$schema:
{
Description: This response object is returned when an error occurs in the Azure Maps API. ,
}
{
error:
{
Description: This object is returned when an error occurs in the Azure Maps API. ,
Required: False ,
}
{
code:
{
Description: The ODataError code. ,
Required: False ,
}
string ,
message:
{
Description: If available, a human-readable description of the error. ,
Required: False ,
}
string ,
details:
{
Required: False ,
}
[
string ,
]
,
target:
{
Description: If available, the target causing the error. ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (403)

{
error:
{
Description: This object is returned when an error occurs in the Azure Maps API. ,
Required: False ,
}
{
code:
{
Description: The ODataError code. ,
Required: False ,
}
string ,
message:
{
Description: If available, a human-readable description of the error. ,
Required: False ,
}
string ,
details:
{
Required: False ,
}
[
string ,
]
,
target:
{
Description: If available, the target causing the error. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (404)

{
error:
{
Description: This object is returned when an error occurs in the Azure Maps API. ,
Required: False ,
}
{
code:
{
Description: The ODataError code. ,
Required: False ,
}
string ,
message:
{
Description: If available, a human-readable description of the error. ,
Required: False ,
}
string ,
details:
{
Required: False ,
}
[
string ,
]
,
target:
{
Description: If available, the target causing the error. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (500)

{
error:
{
Description: This object is returned when an error occurs in the Azure Maps API. ,
Required: False ,
}
{
code:
{
Description: The ODataError code. ,
Required: False ,
}
string ,
message:
{
Description: If available, a human-readable description of the error. ,
Required: False ,
}
string ,
details:
{
Required: False ,
}
[
string ,
]
,
target:
{
Description: If available, the target causing the error. ,
Required: False ,
}
string ,
}
,
}
FeatureState_GetStateset (removed)
Description :  **Applies to:** see pricing [tiers](https://aka.ms/AzureMapsPricingTier). Creator makes it possible to develop applications based on your private indoor map data using Azure Maps API and SDK. [This](https://docs.microsoft.com/azure/azure-maps/creator-indoor-maps) article introduces concepts and tools that apply to Azure Maps Creator. This GET API allows the user to get the stateset Information. The stateset Information includes the datasetId associated to the stateset, and the styles of that stateset.
Reference :  Link ¶

⚼ Request

GET:  /featureStateSets/{statesetId}
{
subscription-key:
{
Description: One of the Azure Maps keys provided from an Azure Map Account. Please refer to this [article](https://docs.microsoft.com/azure/azure-maps/how-to-manage-authentication) for details on how to manage authentication. ,
Required: False ,
}
string ,
api-version:
{
Description: Version number of Azure Maps API. Current version is 2.0 ,
Required: True ,
}
string ,
statesetId:
{
Description: The stateset id that was created. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
description:
{
Description: Description associated with the stateset. ,
Required: False ,
}
string ,
datasetIds:
{
Description: Dataset ID associated with the stateset. ,
Required: False ,
}
[
string ,
]
,
statesetStyle:
{
Description: The styles model. ,
Required: False ,
}
{
styles:
{
Description: An array of stateset styles. The style rule could be a numeric or string or a boolean type style rule. Refer to NumberRuleObject, StringRuleObject and BooleanRuleObject definitions [here](https://aka.ms/AzureMapsStatesetStylesObject). ,
Required: False ,
}
[
object ,
]
,
}
,
}

⚐ Response (400)

{
error:
{
Description: This object is returned when an error occurs in the Azure Maps API. ,
Required: False ,
}
{
code:
{
Description: The ODataError code. ,
Required: False ,
}
string ,
message:
{
Description: If available, a human-readable description of the error. ,
Required: False ,
}
string ,
details:
{
Required: False ,
}
[
string ,
]
,
target:
{
Description: If available, the target causing the error. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (401)

{
$headers:
{
www-authenticate:
{
Description: Bearer realm="https://atlas.microsoft.com/", error="invalid_token", error_description="The access token expired" ,
}
string ,
}
,
$schema:
{
Description: This response object is returned when an error occurs in the Azure Maps API. ,
}
{
error:
{
Description: This object is returned when an error occurs in the Azure Maps API. ,
Required: False ,
}
{
code:
{
Description: The ODataError code. ,
Required: False ,
}
string ,
message:
{
Description: If available, a human-readable description of the error. ,
Required: False ,
}
string ,
details:
{
Required: False ,
}
[
string ,
]
,
target:
{
Description: If available, the target causing the error. ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (403)

{
error:
{
Description: This object is returned when an error occurs in the Azure Maps API. ,
Required: False ,
}
{
code:
{
Description: The ODataError code. ,
Required: False ,
}
string ,
message:
{
Description: If available, a human-readable description of the error. ,
Required: False ,
}
string ,
details:
{
Required: False ,
}
[
string ,
]
,
target:
{
Description: If available, the target causing the error. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (404)

{
error:
{
Description: This object is returned when an error occurs in the Azure Maps API. ,
Required: False ,
}
{
code:
{
Description: The ODataError code. ,
Required: False ,
}
string ,
message:
{
Description: If available, a human-readable description of the error. ,
Required: False ,
}
string ,
details:
{
Required: False ,
}
[
string ,
]
,
target:
{
Description: If available, the target causing the error. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (500)

{
error:
{
Description: This object is returned when an error occurs in the Azure Maps API. ,
Required: False ,
}
{
code:
{
Description: The ODataError code. ,
Required: False ,
}
string ,
message:
{
Description: If available, a human-readable description of the error. ,
Required: False ,
}
string ,
details:
{
Required: False ,
}
[
string ,
]
,
target:
{
Description: If available, the target causing the error. ,
Required: False ,
}
string ,
}
,
}
FeatureState_UpdateStates (removed)
Description :  **Applies to:** see pricing [tiers](https://aka.ms/AzureMapsPricingTier). Creator makes it possible to develop applications based on your private indoor map data using Azure Maps API and SDK. [This](https://docs.microsoft.com/azure/azure-maps/creator-indoor-maps) article introduces concepts and tools that apply to Azure Maps Creator. This PUT API allows the user to update the state of the given feature in the given stateset.
Reference :  Link ¶

⚼ Request

PUT:  /featureStateSets/{statesetId}/featureStates/{featureId}
{
subscription-key:
{
Description: One of the Azure Maps keys provided from an Azure Map Account. Please refer to this [article](https://docs.microsoft.com/azure/azure-maps/how-to-manage-authentication) for details on how to manage authentication. ,
Required: False ,
}
string ,
api-version:
{
Description: Version number of Azure Maps API. Current version is 2.0 ,
Required: True ,
}
string ,
statesetId:
{
Description: The stateset id that was created. ,
Required: True ,
}
string ,
featureId:
{
Description: The id of a feature in the given dataset. If the featureId is not present in the dataset, Bad Request response will be returned. ,
Required: True ,
}
string ,
featureStateUpdateRequestBody:
{
Description: The feature state JSON data. A feature can have only one state at a given point in time. The specified state keyname must have been defined during the stateset creation. ,
Required: True ,
}
{
states:
{
Description: The feature states array. ,
Required: False ,
}
[
{
keyName:
{
Description: Feature state Keyname. Maximum length allowed is 1000. ,
Required: False ,
}
string ,
value:
{
Description: Value for the feature state. Type should comply with the style definition attached to the featurestate. Maximum length allowed for string type is 1024. ,
Required: False ,
}
object ,
eventTimestamp:
{
Description: Valid Timestamp when the feature state was captured. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}

⚐ Response (200)

{}

⚐ Response (400)

{
error:
{
Description: This object is returned when an error occurs in the Azure Maps API. ,
Required: False ,
}
{
code:
{
Description: The ODataError code. ,
Required: False ,
}
string ,
message:
{
Description: If available, a human-readable description of the error. ,
Required: False ,
}
string ,
details:
{
Required: False ,
}
[
string ,
]
,
target:
{
Description: If available, the target causing the error. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (401)

{
$headers:
{
www-authenticate:
{
Description: Bearer realm="https://atlas.microsoft.com/", error="invalid_token", error_description="The access token expired" ,
}
string ,
}
,
$schema:
{
Description: This response object is returned when an error occurs in the Azure Maps API. ,
}
{
error:
{
Description: This object is returned when an error occurs in the Azure Maps API. ,
Required: False ,
}
{
code:
{
Description: The ODataError code. ,
Required: False ,
}
string ,
message:
{
Description: If available, a human-readable description of the error. ,
Required: False ,
}
string ,
details:
{
Required: False ,
}
[
string ,
]
,
target:
{
Description: If available, the target causing the error. ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (403)

{
error:
{
Description: This object is returned when an error occurs in the Azure Maps API. ,
Required: False ,
}
{
code:
{
Description: The ODataError code. ,
Required: False ,
}
string ,
message:
{
Description: If available, a human-readable description of the error. ,
Required: False ,
}
string ,
details:
{
Required: False ,
}
[
string ,
]
,
target:
{
Description: If available, the target causing the error. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (404)

{
error:
{
Description: This object is returned when an error occurs in the Azure Maps API. ,
Required: False ,
}
{
code:
{
Description: The ODataError code. ,
Required: False ,
}
string ,
message:
{
Description: If available, a human-readable description of the error. ,
Required: False ,
}
string ,
details:
{
Required: False ,
}
[
string ,
]
,
target:
{
Description: If available, the target causing the error. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (500)

{
error:
{
Description: This object is returned when an error occurs in the Azure Maps API. ,
Required: False ,
}
{
code:
{
Description: The ODataError code. ,
Required: False ,
}
string ,
message:
{
Description: If available, a human-readable description of the error. ,
Required: False ,
}
string ,
details:
{
Required: False ,
}
[
string ,
]
,
target:
{
Description: If available, the target causing the error. ,
Required: False ,
}
string ,
}
,
}
FeatureState_DeleteState (removed)
Description :  **Applies to:** see pricing [tiers](https://aka.ms/AzureMapsPricingTier). Creator makes it possible to develop applications based on your private indoor map data using Azure Maps API and SDK. [This](https://docs.microsoft.com/azure/azure-maps/creator-indoor-maps) article introduces concepts and tools that apply to Azure Maps Creator. This API deletes the state information identified by the StateKeyName parameter for the feature identified by the FeatureId parameter in the the stateset.
Reference :  Link ¶

⚼ Request

DELETE:  /featureStateSets/{statesetId}/featureStates/{featureId}
{
subscription-key:
{
Description: One of the Azure Maps keys provided from an Azure Map Account. Please refer to this [article](https://docs.microsoft.com/azure/azure-maps/how-to-manage-authentication) for details on how to manage authentication. ,
Required: False ,
}
string ,
api-version:
{
Description: Version number of Azure Maps API. Current version is 2.0 ,
Required: True ,
}
string ,
statesetId:
{
Description: The stateset id that was created. ,
Required: True ,
}
string ,
featureId:
{
Description: The id of a feature in the given stateset. If no state was set for the featureId in the stateset earlier, Bad Request response will be returned. ,
Required: True ,
}
string ,
stateKeyName:
{
Description: The Name of the state to be deleted. ,
Required: True ,
}
string ,
}

⚐ Response (204)

{}

⚐ Response (400)

{
error:
{
Description: This object is returned when an error occurs in the Azure Maps API. ,
Required: False ,
}
{
code:
{
Description: The ODataError code. ,
Required: False ,
}
string ,
message:
{
Description: If available, a human-readable description of the error. ,
Required: False ,
}
string ,
details:
{
Required: False ,
}
[
string ,
]
,
target:
{
Description: If available, the target causing the error. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (401)

{
$headers:
{
www-authenticate:
{
Description: Bearer realm="https://atlas.microsoft.com/", error="invalid_token", error_description="The access token expired" ,
}
string ,
}
,
$schema:
{
Description: This response object is returned when an error occurs in the Azure Maps API. ,
}
{
error:
{
Description: This object is returned when an error occurs in the Azure Maps API. ,
Required: False ,
}
{
code:
{
Description: The ODataError code. ,
Required: False ,
}
string ,
message:
{
Description: If available, a human-readable description of the error. ,
Required: False ,
}
string ,
details:
{
Required: False ,
}
[
string ,
]
,
target:
{
Description: If available, the target causing the error. ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (403)

{
error:
{
Description: This object is returned when an error occurs in the Azure Maps API. ,
Required: False ,
}
{
code:
{
Description: The ODataError code. ,
Required: False ,
}
string ,
message:
{
Description: If available, a human-readable description of the error. ,
Required: False ,
}
string ,
details:
{
Required: False ,
}
[
string ,
]
,
target:
{
Description: If available, the target causing the error. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (404)

{
error:
{
Description: This object is returned when an error occurs in the Azure Maps API. ,
Required: False ,
}
{
code:
{
Description: The ODataError code. ,
Required: False ,
}
string ,
message:
{
Description: If available, a human-readable description of the error. ,
Required: False ,
}
string ,
details:
{
Required: False ,
}
[
string ,
]
,
target:
{
Description: If available, the target causing the error. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (409)

{
error:
{
Description: This object is returned when an error occurs in the Azure Maps API. ,
Required: False ,
}
{
code:
{
Description: The ODataError code. ,
Required: False ,
}
string ,
message:
{
Description: If available, a human-readable description of the error. ,
Required: False ,
}
string ,
details:
{
Required: False ,
}
[
string ,
]
,
target:
{
Description: If available, the target causing the error. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (500)

{
error:
{
Description: This object is returned when an error occurs in the Azure Maps API. ,
Required: False ,
}
{
code:
{
Description: The ODataError code. ,
Required: False ,
}
string ,
message:
{
Description: If available, a human-readable description of the error. ,
Required: False ,
}
string ,
details:
{
Required: False ,
}
[
string ,
]
,
target:
{
Description: If available, the target causing the error. ,
Required: False ,
}
string ,
}
,
}
FeatureState_GetStates (removed)
Description :  **Applies to:** see pricing [tiers](https://aka.ms/AzureMapsPricingTier). Creator makes it possible to develop applications based on your private indoor map data using Azure Maps API and SDK. [This](https://docs.microsoft.com/azure/azure-maps/creator-indoor-maps) article introduces concepts and tools that apply to Azure Maps Creator. This API returns the current state information associated with the given feature in the given stateset.
Reference :  Link ¶

⚼ Request

GET:  /featureStateSets/{statesetId}/featureStates/{featureId}
{
subscription-key:
{
Description: One of the Azure Maps keys provided from an Azure Map Account. Please refer to this [article](https://docs.microsoft.com/azure/azure-maps/how-to-manage-authentication) for details on how to manage authentication. ,
Required: False ,
}
string ,
api-version:
{
Description: Version number of Azure Maps API. Current version is 2.0 ,
Required: True ,
}
string ,
statesetId:
{
Description: The stateset id that was created. ,
Required: True ,
}
string ,
featureId:
{
Description: The id of a feature in the given stateset. If no state was set for the featureId in the stateset earlier, Bad Request response will be returned. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
states:
{
Description: The feature states array. ,
Required: False ,
}
[
{
keyName:
{
Description: Feature state Keyname. Maximum length allowed is 1000. ,
Required: False ,
}
string ,
value:
{
Description: Value for the feature state. Type should comply with the style definition attached to the featurestate. Maximum length allowed for string type is 1024. ,
Required: False ,
}
object ,
eventTimestamp:
{
Description: Valid Timestamp when the feature state was captured. ,
Required: False ,
}
string ,
}
,
]
,
}

⚐ Response (400)

{
error:
{
Description: This object is returned when an error occurs in the Azure Maps API. ,
Required: False ,
}
{
code:
{
Description: The ODataError code. ,
Required: False ,
}
string ,
message:
{
Description: If available, a human-readable description of the error. ,
Required: False ,
}
string ,
details:
{
Required: False ,
}
[
string ,
]
,
target:
{
Description: If available, the target causing the error. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (401)

{
$headers:
{
www-authenticate:
{
Description: Bearer realm="https://atlas.microsoft.com/", error="invalid_token", error_description="The access token expired" ,
}
string ,
}
,
$schema:
{
Description: This response object is returned when an error occurs in the Azure Maps API. ,
}
{
error:
{
Description: This object is returned when an error occurs in the Azure Maps API. ,
Required: False ,
}
{
code:
{
Description: The ODataError code. ,
Required: False ,
}
string ,
message:
{
Description: If available, a human-readable description of the error. ,
Required: False ,
}
string ,
details:
{
Required: False ,
}
[
string ,
]
,
target:
{
Description: If available, the target causing the error. ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (403)

{
error:
{
Description: This object is returned when an error occurs in the Azure Maps API. ,
Required: False ,
}
{
code:
{
Description: The ODataError code. ,
Required: False ,
}
string ,
message:
{
Description: If available, a human-readable description of the error. ,
Required: False ,
}
string ,
details:
{
Required: False ,
}
[
string ,
]
,
target:
{
Description: If available, the target causing the error. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (404)

{
error:
{
Description: This object is returned when an error occurs in the Azure Maps API. ,
Required: False ,
}
{
code:
{
Description: The ODataError code. ,
Required: False ,
}
string ,
message:
{
Description: If available, a human-readable description of the error. ,
Required: False ,
}
string ,
details:
{
Required: False ,
}
[
string ,
]
,
target:
{
Description: If available, the target causing the error. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (500)

{
error:
{
Description: This object is returned when an error occurs in the Azure Maps API. ,
Required: False ,
}
{
code:
{
Description: The ODataError code. ,
Required: False ,
}
string ,
message:
{
Description: If available, a human-readable description of the error. ,
Required: False ,
}
string ,
details:
{
Required: False ,
}
[
string ,
]
,
target:
{
Description: If available, the target causing the error. ,
Required: False ,
}
string ,
}
,
}